<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>IDA SDK: Stack variable flags</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">IDA SDK
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="files.html"><span>Header&#160;Files</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Stack variable flags</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Passed as 'flags' parameter to <a class="el" href="classinsn__t.html#a472e9683a9b08934e5866320dc6b1b9e" title="Create or modify a stack variable in the function frame. ">create_stkvar()</a> </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga092b82ad35c97df5541f8f7b59c5720f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_t_k_v_a_r__2.html#ga092b82ad35c97df5541f8f7b59c5720f">insn_t::add_cref</a> (<a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> to, int opoff, <a class="el" href="group__xref__type.html#ga44e2b79869a9595bbe6265ff2026aa98">cref_t</a> type) const </td></tr>
<tr class="memdesc:ga092b82ad35c97df5541f8f7b59c5720f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a code cross-reference from the instruction.  <a href="#ga092b82ad35c97df5541f8f7b59c5720f">More...</a><br /></td></tr>
<tr class="separator:ga092b82ad35c97df5541f8f7b59c5720f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga498f6c9430345fbbcda11d8fcd108deb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_t_k_v_a_r__2.html#ga498f6c9430345fbbcda11d8fcd108deb">insn_t::add_dref</a> (<a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> to, int opoff, <a class="el" href="group__xref__type.html#ga78aab6d0d6bd9cb4904bbdbb5ac4fa71">dref_t</a> type) const </td></tr>
<tr class="memdesc:ga498f6c9430345fbbcda11d8fcd108deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a data cross-reference from the instruction.  <a href="#ga498f6c9430345fbbcda11d8fcd108deb">More...</a><br /></td></tr>
<tr class="separator:ga498f6c9430345fbbcda11d8fcd108deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9adc3c8e4695148f4892253ea1b067ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_t_k_v_a_r__2.html#ga9adc3c8e4695148f4892253ea1b067ff">insn_t::add_off_drefs</a> (const <a class="el" href="classop__t.html">op_t</a> &amp;x, <a class="el" href="group__xref__type.html#ga78aab6d0d6bd9cb4904bbdbb5ac4fa71">dref_t</a> type, int outf) const </td></tr>
<tr class="memdesc:ga9adc3c8e4695148f4892253ea1b067ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add xrefs for an operand of the instruction.  <a href="#ga9adc3c8e4695148f4892253ea1b067ff">More...</a><br /></td></tr>
<tr class="separator:ga9adc3c8e4695148f4892253ea1b067ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Emulator helpers</h2></td></tr>
<tr class="memitem:gadea83308bbe3028f66bde2b06d3931e1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_t_k_v_a_r__2.html#gadea83308bbe3028f66bde2b06d3931e1">STKVAR_VALID_SIZE</a>&#160;&#160;&#160;0x0001</td></tr>
<tr class="memdesc:gadea83308bbe3028f66bde2b06d3931e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">x.dtype contains correct variable type  <a href="#gadea83308bbe3028f66bde2b06d3931e1">More...</a><br /></td></tr>
<tr class="separator:gadea83308bbe3028f66bde2b06d3931e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gadea83308bbe3028f66bde2b06d3931e1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STKVAR_VALID_SIZE&#160;&#160;&#160;0x0001</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>x.dtype contains correct variable type </p>
<p>(for insns like 'lea' this bit must be off) in general, dr_O references do not allow to determine the variable size </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga092b82ad35c97df5541f8f7b59c5720f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void insn_t::add_cref </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a>&#160;</td>
          <td class="paramname"><em>to</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>opoff</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xref__type.html#ga44e2b79869a9595bbe6265ff2026aa98">cref_t</a>&#160;</td>
          <td class="paramname"><em>type</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add a code cross-reference from the instruction. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">opoff</td><td>offset of the operand from the start of instruction. if the offset is unknown, then 0. </td></tr>
    <tr><td class="paramname">to</td><td>target linear address </td></tr>
    <tr><td class="paramname">type</td><td>type of xref </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga498f6c9430345fbbcda11d8fcd108deb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void insn_t::add_dref </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a>&#160;</td>
          <td class="paramname"><em>to</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>opoff</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xref__type.html#ga78aab6d0d6bd9cb4904bbdbb5ac4fa71">dref_t</a>&#160;</td>
          <td class="paramname"><em>type</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add a data cross-reference from the instruction. </p>
<p>See <a class="el" href="group___s_t_k_v_a_r__2.html#ga9adc3c8e4695148f4892253ea1b067ff" title="Add xrefs for an operand of the instruction. ">add_off_drefs()</a> - usually it can be used in most cases. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">opoff</td><td>offset of the operand from the start of instruction if the offset is unknown, then 0 </td></tr>
    <tr><td class="paramname">to</td><td>target linear address </td></tr>
    <tr><td class="paramname">type</td><td>type of xref </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga9adc3c8e4695148f4892253ea1b067ff"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="pro_8h.html#a7b0aeaed04e477c02cf8ea3452002d1a">ea_t</a> insn_t::add_off_drefs </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classop__t.html">op_t</a> &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xref__type.html#ga78aab6d0d6bd9cb4904bbdbb5ac4fa71">dref_t</a>&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>outf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add xrefs for an operand of the instruction. </p>
<p>This function creates all cross references for 'offset' and 'structure offset' operands. Use <a class="el" href="group___s_t_k_v_a_r__2.html#ga9adc3c8e4695148f4892253ea1b067ff" title="Add xrefs for an operand of the instruction. ">add_off_drefs()</a> in the presence of negative offsets. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>reference to operand </td></tr>
    <tr><td class="paramname">type</td><td>type of xref </td></tr>
    <tr><td class="paramname">outf</td><td>out_value() flags. These flags should match the flags used to output the operand </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>if <a class="el" href="group___f_f__opfuncs2.html#gae2674933600c8a1e3aed29cd52466766" title="is offset? ">is_off()</a>, the reference target address (the same as calc_reference_data). else, <a class="el" href="pro_8h.html#a63a7c1cde5fb0cf0d0023d55c742dd4f" title="this value is used for &#39;bad address&#39; ">BADADDR</a>, because for stroffs the target address is unknown </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
